List aggregate allocations timeseries data matching the provided filters.
This can return multiple values per ISP for one aggregate allocation. You tell those values apart by their finality and known_at. See Multiple values per timestep.
To read the energy volumes of one aggregate allocation, use the external_id filter, and the flow_direction filter if the external id has both directions. List Aggregate Allocation Series gives the external id of each aggregate allocation.
GET
/
market-access
/
v1alpha1
/
timeseries
/
aggregate-allocations
List Aggregate Allocations
curl --request GET \ --url https://api.engrate.io/market-access/v1alpha1/timeseries/aggregate-allocations \ --header 'Authorization: <api-key>'
Areas to read, each one as kind:code, where kind is one of metering_grid_area, control_area or scheduling_area, for example scheduling_area:10YDE-RWENET---I. Omit this parameter to read every area.
Allocation bases to read. Omit to read every basis.
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.
Market dimensions to filter by, as key:value. A market dimension is the market's own key and code on which it divides accounting points, for example series_type:SLS. An aggregate allocation matches when it carries every pair.
Market metadata to filter by, as key:value. Market-specific metadata distinguishes aggregate allocations with the same aggregation dimensions, for example those sent at different cadences (daily, monthly). For example, summed_series:ZA0 selects category C balance group summed series. An aggregate allocation matches when its market metadata contains every pair.
{"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":""},"chroma":{"liveDeploymentHistoryId":"6aec6664802fe9fbb7656a96","collectionId":"77d2be5c-f79d-410b-a011-7baf8b18f094","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec6664802fe9fbb7656a96"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6aec6a7a802fe9fbb76575b6","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API reference","count":107},{"language":"default","tag":"Market Communication","count":56},{"language":"default","tag":"Cost of Energy","count":43},{"language":"default","tag":"Tariffs","count":43},{"language":"default","tag":"Models","count":33},{"language":"default","tag":"Documentation","count":20},{"language":"default","tag":"Core","count":19},{"language":"default","tag":"Market reference data","count":19},{"language":"default","tag":"Schedules","count":17},{"language":"default","tag":"Allocations","count":15}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"llms-txt-v2","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":"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":"vite-origin","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":"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}],"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/timeseries/list-aggregate-allocations","slug":"/api-reference/timeseries/list-aggregate-allocations","pageMetadata":{"title":"List Aggregate Allocations","description":"List aggregate allocations timeseries data matching the provided filters.\n\nThis can return multiple values per ISP for one aggregate allocation. You tell those values apart by their [finality](/api-reference/allocations/models/finality) and `known_at`. See [Multiple values per timestep](/api-reference/allocations/overview#multiple-values-per-timestep).\n\nTo read the energy volumes of one aggregate allocation, use the `external_id` filter, and the `flow_direction` filter if the external id has both directions. List Aggregate Allocation Series gives the external id of each aggregate allocation.","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/timeseries/aggregate-allocations","href":"/api-reference/timeseries/list-aggregate-allocations","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"List aggregate allocations timeseries data matching the provided filters.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This can return multiple values per ISP for one aggregate allocation. You tell those values apart by their \", _jsx(_components.a, {\n href: \"/api-reference/allocations/models/finality\",\n children: \"finality\"\n }), \" and \", _jsx(_components.code, {\n children: \"known_at\"\n }), \". See \", _jsx(_components.a, {\n href: \"/api-reference/allocations/overview#multiple-values-per-timestep\",\n children: \"Multiple values per timestep\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"To read the energy volumes of one aggregate allocation, use the \", _jsx(_components.code, {\n children: \"external_id\"\n }), \" filter, and the \", _jsx(_components.code, {\n children: \"flow_direction\"\n }), \" filter if the external id has both directions. List Aggregate Allocation Series gives the external id of each aggregate allocation.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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":"List Aggregate Allocations","description":"List aggregate allocations timeseries data matching the provided filters.\n\nThis can return multiple values per ISP for one aggregate allocation. You tell those values apart by their [finality](/api-reference/allocations/models/finality) and `known_at`. See [Multiple values per timestep](/api-reference/allocations/overview#multiple-values-per-timestep).\n\nTo read the energy volumes of one aggregate allocation, use the `external_id` filter, and the `flow_direction` filter if the external id has both directions. List Aggregate Allocation Series gives the external id of each aggregate allocation.","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/timeseries/aggregate-allocations","href":"/api-reference/timeseries/list-aggregate-allocations","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"List aggregate allocations timeseries data matching the provided filters.\n\nThis can return multiple values per ISP for one aggregate allocation. You tell those values apart by their [finality](/api-reference/allocations/models/finality) and `known_at`. See [Multiple values per timestep](/api-reference/allocations/overview#multiple-values-per-timestep).\n\nTo read the energy volumes of one aggregate allocation, use the `external_id` filter, and the `flow_direction` filter if the external id has both directions. List Aggregate Allocation Series gives the external id of each aggregate allocation.","operationId":"list_aggregate_allocations_market_access_v1alpha1_timeseries_aggregate_allocations_get","parameters":["4d82044b-c296-4928-9382-701769fb201a","5723af12-1aa3-4432-8966-542ea6bd6551","235549e9-9875-4936-a4c7-f6a2dea5750f","4084dd34-2419-4a84-9f7c-ea619f928881","fe756407-04ff-4810-b2b2-2db7fc82d1d2","86c29dcd-1f85-4668-8cca-1e78b1c48e96","3b2abcf9-4ad7-4726-a4f5-9ca208bd41fa","e77a3542-ae7f-4f88-999d-bc33a391149a","48984e02-2f7c-4a14-8854-49ead7e80800","b4fe8ac5-e4a9-4081-b3f3-26a2f2627d8f","8ab9adc6-24f1-43f4-9515-202aea6c6c14"],"responses":{"200":"1a4eccac-47e9-4471-907f-32898448fe86","422":"cda51648-4e6a-4e68-865e-103d4e38d273"},"summary":"List Aggregate Allocations","tags":["timeseries"],"method":"get","type":"path","servers":["56f8d7d5-8553-4e45-9b51-393264332a7f"],"security":["cb320931-329b-4803-8c4e-c484fc8d3f0a"],"path":"/market-access/v1alpha1/timeseries/aggregate-allocations","baseUrlOptions":["https://api.engrate.io"],"title":"List Aggregate Allocations","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4d82044b-c296-4928-9382-701769fb201a":{"description":"Inclusive lower bound on the settlement period start (RFC 3339).","in":"query","name":"isp_from","required":true,"schema":{"description":"Inclusive lower bound on the settlement period start (RFC 3339).","format":"date-time","title":"Isp From","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"5723af12-1aa3-4432-8966-542ea6bd6551":{"description":"Exclusive upper bound on the settlement period start (RFC 3339).","in":"query","name":"isp_until","required":true,"schema":{"description":"Exclusive upper bound on the settlement period start (RFC 3339).","format":"date-time","title":"Isp Until","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"235549e9-9875-4936-a4c7-f6a2dea5750f":{"description":"External ids of the aggregate allocations to read.","in":"query","name":"external_id","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"External Id","description":"External ids of the aggregate allocations to read.","maxItems":500,"uniqueKey":"oneOf.0","typeLabel":"string[]"},{"type":"null","title":"External Id","description":"External ids of the aggregate allocations to read.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"}},"4084dd34-2419-4a84-9f7c-ea619f928881":{"description":"Areas to read, each one as kind:code, where kind is one of metering_grid_area, control_area or scheduling_area, for example scheduling_area:10YDE-RWENET---I. Omit this parameter to read every area.","in":"query","name":"area","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Area","description":"Areas to read, each one as kind:code, where kind is one of metering_grid_area, control_area or scheduling_area, for example scheduling_area:10YDE-RWENET---I. Omit this parameter to read every area.","maxItems":500,"uniqueKey":"oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Area","description":"Areas to read, each one as kind:code, where kind is one of metering_grid_area, control_area or scheduling_area, for example scheduling_area:10YDE-RWENET---I. Omit this parameter to read every area.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"}},"fe756407-04ff-4810-b2b2-2db7fc82d1d2":{"description":"Flow directions to read. Omit to read both.","in":"query","name":"flow_direction","required":false,"schema":{"oneOf":[{"type":"array","items":{"enum":["consumption","production"],"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Flow Direction","description":"Flow directions to read. Omit to read both.","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Flow Direction","description":"Flow directions to read. Omit to read both.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[] | null"}},"86c29dcd-1f85-4668-8cca-1e78b1c48e96":{"description":"Balance groups to read. Omit to read every group.","in":"query","name":"balance_group","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Balance Group","description":"Balance groups to read. Omit to read every group.","maxItems":500,"uniqueKey":"oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Balance Group","description":"Balance groups to read. Omit to read every group.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"}},"3b2abcf9-4ad7-4726-a4f5-9ca208bd41fa":{"description":"Suppliers to read. Omit to read every supplier.","in":"query","name":"supplier","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Supplier","description":"Suppliers to read. Omit to read every supplier.","maxItems":500,"uniqueKey":"oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Supplier","description":"Suppliers to read. Omit to read every supplier.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"}},"e77a3542-ae7f-4f88-999d-bc33a391149a":{"description":"Aggregator roles to read. Omit to read every role.","in":"query","name":"aggregator","required":false,"schema":{"oneOf":[{"type":"array","items":{"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","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Aggregator","description":"Aggregator roles to read. Omit to read every role.","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Aggregator","description":"Aggregator roles to read. Omit to read every role.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[] | null"}},"48984e02-2f7c-4a14-8854-49ead7e80800":{"description":"Allocation bases to read. Omit to read every basis.","in":"query","name":"allocation_basis","required":false,"schema":{"oneOf":[{"type":"array","items":{"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","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Allocation Basis","description":"Allocation bases to read. Omit to read every basis.","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Allocation Basis","description":"Allocation bases to read. Omit to read every basis.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[] | null"}},"b4fe8ac5-e4a9-4081-b3f3-26a2f2627d8f":{"description":"Market dimensions to filter by, as key:value. A market dimension is the market's own key and code on which it divides accounting points, for example series_type:SLS. An aggregate allocation matches when it carries every pair.","in":"query","name":"market_dimension","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Market Dimension","description":"Market dimensions to filter by, as key:value. A market dimension is the market's own key and code on which it divides accounting points, for example series_type:SLS. An aggregate allocation matches when it carries every pair.","maxItems":500,"uniqueKey":"oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Market Dimension","description":"Market dimensions to filter by, as key:value. A market dimension is the market's own key and code on which it divides accounting points, for example series_type:SLS. An aggregate allocation matches when it carries every pair.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"}},"8ab9adc6-24f1-43f4-9515-202aea6c6c14":{"description":"Market metadata to filter by, as key:value. Market-specific metadata distinguishes aggregate allocations with the same aggregation dimensions, for example those sent at different cadences (daily, monthly). For example, summed_series:ZA0 selects category C balance group summed series. An aggregate allocation matches when its market metadata contains every pair.","in":"query","name":"market_meta","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Market Meta","description":"Market metadata to filter by, as key:value. Market-specific metadata distinguishes aggregate allocations with the same aggregation dimensions, for example those sent at different cadences (daily, monthly). For example, summed_series:ZA0 selects category C balance group summed series. An aggregate allocation matches when its market metadata contains every pair.","maxItems":500,"uniqueKey":"oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Market Meta","description":"Market metadata to filter by, as key:value. Market-specific metadata distinguishes aggregate allocations with the same aggregation dimensions, for example those sent at different cadences (daily, monthly). For example, summed_series:ZA0 selects category C balance group summed series. An aggregate allocation matches when its market metadata contains every pair.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"}}},"responses":{"1a4eccac-47e9-4471-907f-32898448fe86":{"content":{"application/json":{"schema":{"properties":{"values":{"items":{"description":"An energy volume for one aggregate timeseries and one Imbalance Settlement Period (ISP).","properties":{"external_id":{"title":"External Id","type":"string","isRequired":true,"uniqueKey":"values.items.[INDEX].external_id","typeLabel":"string"},"finality":{"description":"How final the volume is. See [Finality and quality in each market](/market-communication/allocations/aggregate-allocations#finality-and-quality-in-each-market) for the codes and rules of each market and the finality Engrate gives them.","enum":["preliminary","revised","final","correction"],"examples":["final"],"title":"Finality","type":"string","isRequired":true,"uniqueKey":"values.items.[INDEX].finality","typeLabel":"enum\u003cstring>"},"flow_direction":{"enum":["consumption","production"],"title":"Flow Direction","type":"string","isRequired":true,"uniqueKey":"values.items.[INDEX].flow_direction","typeLabel":"enum\u003cstring>"},"isp_resolution_minutes":{"description":"The length of the ISP in minutes. This is usually 15, 30 or 60, depending on the market.","title":"Isp Resolution Minutes","type":"integer","isRequired":true,"uniqueKey":"values.items.[INDEX].isp_resolution_minutes","typeLabel":"integer"},"isp_time":{"description":"The start of the Imbalance Settlement Period (ISP), as an ISO 8601 timestamp in UTC, for example `2026-01-01T00:00:00Z`.","examples":["2026-09-26T22:00:00Z"],"format":"date-time","title":"Isp Time","type":"string","isRequired":true,"uniqueKey":"values.items.[INDEX].isp_time","typeLabel":"string\u003cdate-time>"},"known_at":{"description":"When Engrate ingested the record, as an ISO 8601 timestamp in UTC. Use it to prevent look-ahead bias when you fit models: leave out the records that Engrate ingested after the time your model runs.","format":"date-time","title":"Known At","type":"string","isRequired":true,"uniqueKey":"values.items.[INDEX].known_at","typeLabel":"string\u003cdate-time>"},"quality":{"description":"How the market arrived at the volume. See [Finality and quality in each market](/market-communication/allocations/aggregate-allocations#finality-and-quality-in-each-market) for the codes each market sends and the quality Engrate gives them.","enum":["provisional","estimated","calculated","measured"],"examples":["calculated"],"title":"AllocationQuality","type":"string","isRequired":true,"uniqueKey":"values.items.[INDEX].quality","typeLabel":"enum\u003cstring>"},"volume_wh":{"title":"Volume Wh","type":"integer","isRequired":true,"uniqueKey":"values.items.[INDEX].volume_wh","typeLabel":"integer"}},"required":["external_id","finality","flow_direction","isp_resolution_minutes","isp_time","known_at","quality","volume_wh"],"title":"AggregateAllocationRecord","type":"object","uniqueKey":"values.items.[INDEX]","typeLabel":"AggregateAllocationRecord · object"},"title":"Values","type":"array","isRequired":true,"uniqueKey":"values","typeLabel":"AggregateAllocationRecord · object[]"}},"required":["values"],"title":"AggregateAllocationsResponse","type":"object","uniqueKey":"","typeLabel":"AggregateAllocationsResponse · object"},"examples":{"Example":{"title":"Example","value":{"values":[{"external_id":"\u003cstring>","finality":"final","flow_direction":"consumption","isp_resolution_minutes":123,"isp_time":"2026-09-26T22:00:00Z","known_at":"2023-11-07T05:31:56Z","quality":"calculated","volume_wh":123}]}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"cda51648-4e6a-4e68-865e-103d4e38d273":{"content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"title":"Location","type":"array","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"title":"Error Type","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"ctx":{"title":"Context","type":"object","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"title":"Detail","type":"array","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"title":"HTTPValidationError","type":"object","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","ctx":{},"input":"\u003cunknown>"}]}}},"exampleType":"generated"}},"description":"Validation Error","exampleType":"generated"}},"security":{"cb320931-329b-4803-8c4e-c484fc8d3f0a":{"apiKeyAuth":{"in":"header","name":"Authorization","type":"apiKey","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"56f8d7d5-8553-4e45-9b51-393264332a7f":{"url":"https://api.engrate.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"Authorization","type":"apiKey","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"Authorization","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"Authorization"}],"title":"apiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"engrate","siteName":"Engrate Developer Documentation","title":"List Aggregate Allocations - Engrate Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T08:42:20.182Z","originalFileLocation":"api-reference/timeseries/list-aggregate-allocations.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=\"description\" content=\"List aggregate allocations timeseries data matching the provided filters. This can return multiple values per ISP for one aggregate allocation. You tell those values apart by their finality and known_at. See Multiple values per timestep. To read the energy volumes of one aggregate allocation, use the external_id filter, and the flow_direction filter if the external id has both directions. List Aggregate Allocation Series gives the external id of each aggregate allocation.\">\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=\"List Aggregate Allocations - Engrate Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"List aggregate allocations timeseries data matching the provided filters. This can return multiple values per ISP for one aggregate allocation. You tell those values apart by their finality and known_at. See Multiple values per timestep. To read the energy volumes of one aggregate allocation, use the external_id filter, and the flow_direction filter if the external id has both directions. List Aggregate Allocation Series gives the external id of each aggregate allocation.\">\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/timeseries/list-aggregate-allocations\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://engrate.mintlify.app/_mintlify/api/og/v2?division=Allocations\u0026amp;title=List+Aggregate+Allocations\u0026amp;description=List+aggregate+allocations+timeseries+data+matching+the+provided+filters.%0A%0AThis+can+return+multiple+values+per+ISP+for+one+aggregate+allocation.+You+tell+those+\u0026amp;theme=afa5e8a3bcc00498066c4a3e\u0026amp;signature=ff36610063348d1f1d099688272d38565f766d732b637cc0e28dcd12f6b09934\">\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=\"List Aggregate Allocations - Engrate Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List aggregate allocations timeseries data matching the provided filters. This can return multiple values per ISP for one aggregate allocation. You tell those values apart by their finality and known_at. See Multiple values per timestep. To read the energy volumes of one aggregate allocation, use the external_id filter, and the flow_direction filter if the external id has both directions. List Aggregate Allocation Series gives the external id of each aggregate allocation.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://engrate.mintlify.app/_mintlify/api/og/v2?division=Allocations\u0026amp;title=List+Aggregate+Allocations\u0026amp;description=List+aggregate+allocations+timeseries+data+matching+the+provided+filters.%0A%0AThis+can+return+multiple+values+per+ISP+for+one+aggregate+allocation.+You+tell+those+\u0026amp;theme=afa5e8a3bcc00498066c4a3e\u0026amp;signature=ff36610063348d1f1d099688272d38565f766d732b637cc0e28dcd12f6b09934\">\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/timeseries/list-aggregate-allocations\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/timeseries/list-aggregate-allocations.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/timeseries/list-aggregate-allocations#webpage\",\"url\":\"https://docs.engrate.io/api-reference/timeseries/list-aggregate-allocations\",\"name\":\"List Aggregate Allocations\",\"description\":\"List aggregate allocations timeseries data matching the provided filters. This can return multiple values per ISP for one aggregate allocation. You tell those values apart by their finality and known_at. See Multiple values per timestep. To read the energy volumes of one aggregate allocation, use the external_id filter, and the flow_direction filter if the external id has both directions. List Aggregate Allocation Series gives the external id of each aggregate allocation.\",\"dateModified\":\"2026-11-05T08:42:20.182Z\",\"isPartOf\":{\"@id\":\"https://docs.engrate.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.engrate.io/api-reference/timeseries/list-aggregate-allocations#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.engrate.io/api-reference/timeseries/list-aggregate-allocations#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\":\"List Aggregate Allocations\",\"item\":\"https://docs.engrate.io/api-reference/timeseries/list-aggregate-allocations\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.engrate.io/api-reference/timeseries/list-aggregate-allocations#apireference\",\"headline\":\"List Aggregate Allocations\",\"name\":\"List Aggregate Allocations\",\"description\":\"List aggregate allocations timeseries data matching the provided filters. This can return multiple values per ISP for one aggregate allocation. You tell those values apart by their finality and known_at. See Multiple values per timestep. To read the energy volumes of one aggregate allocation, use the external_id filter, and the flow_direction filter if the external id has both directions. List Aggregate Allocation Series gives the external id of each aggregate allocation.\",\"url\":\"https://docs.engrate.io/api-reference/timeseries/list-aggregate-allocations\",\"mainEntityOfPage\":{\"@id\":\"https://docs.engrate.io/api-reference/timeseries/list-aggregate-allocations#webpage\"},\"dateModified\":\"2026-11-05T08:42:20.182Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","href":"/api-reference/allocations/models/aggregate-allocation-record"},{"title":"Aggregate allocation","href":"/api-reference/allocations/models/aggregate-allocation"},{"title":"Finality","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","description":"Show the allocation series that agree with the filters.\n\nEach series holds the allocations of one flow direction at one accounting point. Use its `accounting_point_id` to read its values in List Allocations. Use the `market_identifier` filter to find the accounting point that the market identifies by an EAN code or another identifier.\n\nThe list shows the series in the sequence of `accounting_point_id`, then `flow_direction`. To read the full list, use `offset` and `limit` to get one page at a time. `total` is the number of series that agree with the filters, on all pages.\n\nThe API gives the status code 422 in these conditions:\n\n- An `accounting_point_id` filter is not a UUID.\n\n- A `flow_direction` filter has an unknown value.\n\n- An `accounting_point_id` or `market_identifier` filter has more values than its maximum.\n\n- `offset` is less than 0 or more than its maximum, or `limit` is less than 1 or more than its maximum.","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","description":"List Aggregate Allocation Series.\n\nAggregate Allocations are grouped into separate logical series. Markets assign the series identifiers, and Engrate tracks the dimensions for each series - like what area it applies to, flow direction, and so on.\n\nThis endpoint lets you list the individual series and their dimensions.\n\nIf a returned dimension is null, it indicates the series applies for all values of that dimension.\n\nThe list shows the aggregate allocations in the sequence of `external_id`, then `flow_direction`. To read the full list, use `offset` and `limit` to get one page at a time. `total` is the number of aggregate allocations that agree with the filters, on all pages.\n\nThe API gives the status code 422 in these conditions:\n\n- An `area` filter is not in the format `kind:code`, or it has an unknown area kind.\n\n- A `market_dimension` filter is not in the format `key:value`.\n\n- A `market_dimension` filter has one key two times.\n\n- A `market_meta` filter value is not in the format `key:value`.\n\n- A `market_meta` filter repeats a key.\n\n- A `flow_direction`, `aggregator` or `allocation_basis` filter has an unknown value.\n\n- An `external_id`, `area`, `balance_group`, `supplier`, `market_dimension` or `market_meta` filter exceeds its maximum number of values.\n\n- `offset` is less than 0 or more than its maximum, or `limit` is less than 1 or more than its maximum.","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":"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":"List Aggregate Allocations - Engrate Developer Documentation","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}