List the imbalance volumes that agree with the filters.
Each imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. On a total, a positive volume means that the balance group was long. On an adjustment, a positive volume makes the balance group longer.
This can return more than one record per ISP for one imbalance series. Use the record with the highest finality, then the latest stated_at. When records have the same values in both fields, use the first of them in the response.
The total includes its adjustments, and the net adjustment includes the adjustment classes. Do not add volumes across these levels.
The API gives the status code 422 in these conditions:
isp_from or isp_until is missing, or it has no time zone offset.
A market_dimension filter is not in the format key:value.
A market_dimension filter has one key two times.
A component_kind or component_value filter has an unknown value.
An external_id, scheduling_area, balance_group or market_dimension filter exceeds its maximum number of values.
GET
/
market-access
/
v1alpha1
/
timeseries
/
imbalance
List Imbalances
curl --request GET \ --url https://api.engrate.io/market-access/v1alpha1/timeseries/imbalance \ --header 'Authorization: <api-key>'
Component values to read. Omit to read every value.
The adjustment class of an imbalance series and its suffix: _up or _down for the regulation direction, _net for one signed series. ALL contains the classes, and each _net contains its _up and _down, thus never add across these levels.
Available imbalance component values
ALL — On a total, the imbalance. On an adjustment, the net of all the adjustments that the market sends.
afrr_up — Automatic frequency restoration reserve (aFRR), upward regulation.
afrr_down — aFRR, downward regulation.
afrr_net — aFRR, both directions in one signed series.
mfrr_up — Manual frequency restoration reserve (mFRR), upward regulation.
mfrr_down — mFRR, downward regulation.
mfrr_net — mFRR, both directions in one signed series.
Market dimensions to filter by, as key:value. A market dimension is the market's own key and code for an imbalance series, for example the code of an adjustment class. A series matches when it has 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":"6ae9e1e84323a0c25b2c6450","collectionId":"8a7eaedb-b176-4b53-b2bf-9edf686915cb","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae9e1e84323a0c25b2c6450"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae9ee7575120cb36f290e4a","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API reference","count":106},{"language":"default","tag":"Market Communication","count":55},{"language":"default","tag":"Cost of Energy","count":43},{"language":"default","tag":"Models","count":33},{"language":"default","tag":"Schedules","count":20},{"language":"default","tag":"Documentation","count":20},{"language":"default","tag":"Allocations","count":19},{"language":"default","tag":"Core","count":19},{"language":"default","tag":"Functions","count":12},{"language":"default","tag":"Conditions","count":10}]},"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":"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":"byok-sep-25","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":"billing-updated-9-15","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}],"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:.75rem}.edgeLabel,.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:0 0!important;border:0!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 .flowchart-link,html.dark marker path,html.dark path.flowchart-link{stroke:#9ca3af!important}html.dark marker path{fill:#9ca3af!important}html.dark .edgeLabel .labelBkg{background:#1e3a5f!important;border-color:#60a5fa;color:#dbeafe!important}html.dark .edgeLabel .labelBkg span,html.dark .edgeLabel span{color:#dbeafe!important}"}],"page":{"pagePath":"api-reference/timeseries/list-imbalances","slug":"/api-reference/timeseries/list-imbalances","pageMetadata":{"title":"List Imbalances","description":"List the imbalance volumes that agree with the filters.\n\nEach imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. On a total, a positive volume means that the balance group was long. On an adjustment, a positive volume makes the balance group longer.\n\nThis can return more than one record per ISP for one imbalance series. Use the record with the highest `finality`, then the latest `stated_at`. When records have the same values in both fields, use the first of them in the response.\n\nThe total includes its adjustments, and the net adjustment includes the adjustment classes. Do not add volumes across these levels.\n\nThe API gives the status code 422 in these conditions:\n\n- `isp_from` or `isp_until` is missing, or it has no time zone offset.\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 `component_kind` or `component_value` filter has an unknown value.\n\n- An `external_id`, `scheduling_area`, `balance_group` or `market_dimension` filter exceeds its maximum number of values.","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/timeseries/imbalance","href":"/api-reference/timeseries/list-imbalances","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 code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"List the imbalance volumes that agree with the filters.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Each imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. On a total, a positive volume means that the balance group was long. On an adjustment, a positive volume makes the balance group longer.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This can return more than one record per ISP for one imbalance series. Use the record with the highest \", _jsx(_components.code, {\n children: \"finality\"\n }), \", then the latest \", _jsx(_components.code, {\n children: \"stated_at\"\n }), \". When records have the same values in both fields, use the first of them in the response.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"The total includes its adjustments, and the net adjustment includes the adjustment classes. Do not add volumes across these levels.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The API gives the status code 422 in these conditions:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"isp_from\"\n }), \" or \", _jsx(_components.code, {\n children: \"isp_until\"\n }), \" is missing, or it has no time zone offset.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [\"A \", _jsx(_components.code, {\n children: \"market_dimension\"\n }), \" filter is not in the format \", _jsx(_components.code, {\n children: \"key:value\"\n }), \".\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [\"A \", _jsx(_components.code, {\n children: \"market_dimension\"\n }), \" filter has one key two times.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [\"A \", _jsx(_components.code, {\n children: \"component_kind\"\n }), \" or \", _jsx(_components.code, {\n children: \"component_value\"\n }), \" filter has an unknown value.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [\"An \", _jsx(_components.code, {\n children: \"external_id\"\n }), \", \", _jsx(_components.code, {\n children: \"scheduling_area\"\n }), \", \", _jsx(_components.code, {\n children: \"balance_group\"\n }), \" or \", _jsx(_components.code, {\n children: \"market_dimension\"\n }), \" filter exceeds its maximum number of values.\"]\n }), \"\\n\"]\n }), \"\\n\"]\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 Imbalances","description":"List the imbalance volumes that agree with the filters.\n\nEach imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. On a total, a positive volume means that the balance group was long. On an adjustment, a positive volume makes the balance group longer.\n\nThis can return more than one record per ISP for one imbalance series. Use the record with the highest `finality`, then the latest `stated_at`. When records have the same values in both fields, use the first of them in the response.\n\nThe total includes its adjustments, and the net adjustment includes the adjustment classes. Do not add volumes across these levels.\n\nThe API gives the status code 422 in these conditions:\n\n- `isp_from` or `isp_until` is missing, or it has no time zone offset.\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 `component_kind` or `component_value` filter has an unknown value.\n\n- An `external_id`, `scheduling_area`, `balance_group` or `market_dimension` filter exceeds its maximum number of values.","deprecated":null,"version":null,"openapi":"/openapi.json get /market-access/v1alpha1/timeseries/imbalance","href":"/api-reference/timeseries/list-imbalances","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"List the imbalance volumes that agree with the filters.\n\nEach imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. On a total, a positive volume means that the balance group was long. On an adjustment, a positive volume makes the balance group longer.\n\nThis can return more than one record per ISP for one imbalance series. Use the record with the highest `finality`, then the latest `stated_at`. When records have the same values in both fields, use the first of them in the response.\n\nThe total includes its adjustments, and the net adjustment includes the adjustment classes. Do not add volumes across these levels.\n\nThe API gives the status code 422 in these conditions:\n\n- `isp_from` or `isp_until` is missing, or it has no time zone offset.\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 `component_kind` or `component_value` filter has an unknown value.\n\n- An `external_id`, `scheduling_area`, `balance_group` or `market_dimension` filter exceeds its maximum number of values.","operationId":"list_imbalances_market_access_v1alpha1_timeseries_imbalance_get","parameters":["e8caeeaa-e402-4ce9-8b4f-47c9af9ec76f","8d6a5f58-d291-4bd0-8ccd-37737f24bff4","7388d093-513b-48e2-a26b-00c29272641a","de32c4f4-cab7-43a3-a050-a3a280aed6e4","2bb73b76-010f-4f74-a6c8-f5b12171ab73","069559e3-79fc-4f8c-9dcd-41d5c6ae6ba9","89cfcb61-ef05-406b-a83b-0138fbbd317b","faa068d9-61c5-486b-88f6-2fef3d091e15"],"responses":{"200":"8d2846a8-1e46-44d1-8021-02ef11630896","422":"7d55f8e7-bf1a-4472-bbe7-bc3d183a642c"},"summary":"List Imbalances","tags":["timeseries"],"method":"get","type":"path","servers":["2219c5a9-9f66-4c8c-9e40-d681b2196046"],"security":["97dd253d-026b-47d1-8ac4-7d4d04c3064e"],"path":"/market-access/v1alpha1/timeseries/imbalance","baseUrlOptions":["https://api.engrate.io"],"title":"List Imbalances","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e8caeeaa-e402-4ce9-8b4f-47c9af9ec76f":{"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>"}},"8d6a5f58-d291-4bd0-8ccd-37737f24bff4":{"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>"}},"7388d093-513b-48e2-a26b-00c29272641a":{"description":"External ids of the imbalance series 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 imbalance series to read.","maxItems":500,"uniqueKey":"oneOf.0","typeLabel":"string[]"},{"type":"null","title":"External Id","description":"External ids of the imbalance series to read.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"}},"de32c4f4-cab7-43a3-a050-a3a280aed6e4":{"description":"EIC codes of the scheduling areas to read, for example `10YDE-EON------1`. Omit to read every area.","in":"query","name":"scheduling_area","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Scheduling Area","description":"EIC codes of the scheduling areas to read, for example `10YDE-EON------1`. Omit to read every area.","maxItems":500,"uniqueKey":"oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Scheduling Area","description":"EIC codes of the scheduling areas to read, for example `10YDE-EON------1`. Omit to read every area.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"}},"2bb73b76-010f-4f74-a6c8-f5b12171ab73":{"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"}},"069559e3-79fc-4f8c-9dcd-41d5c6ae6ba9":{"description":"Component kinds to read. Omit to read both.","in":"query","name":"component_kind","required":false,"schema":{"oneOf":[{"type":"array","items":{"description":"The level of an imbalance series. The total contains the adjustments, thus do not add a total and its adjustments together.\n\n### Available imbalance component kinds\n\n- **total** — The imbalance of the balance group, with all adjustments included.\n\n- **adjustment** — An adjustment that the market included in the imbalance, with the sign it has in the imbalance.","enum":["total","adjustment"],"examples":["total"],"title":"ImbalanceComponentKind","type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Component Kind","description":"Component kinds to read. Omit to read both.","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Component Kind","description":"Component kinds to read. Omit to read both.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[] | null"}},"89cfcb61-ef05-406b-a83b-0138fbbd317b":{"description":"Component values to read. Omit to read every value.","in":"query","name":"component_value","required":false,"schema":{"oneOf":[{"type":"array","items":{"description":"The adjustment class of an imbalance series and its suffix: `_up` or `_down` for the regulation direction, `_net` for one signed series. `ALL` contains the classes, and each `_net` contains its `_up` and `_down`, thus never add across these levels.\n\n### Available imbalance component values\n\n- **ALL** — On a total, the imbalance. On an adjustment, the net of all the adjustments that the market sends.\n\n- **afrr_up** — Automatic frequency restoration reserve (aFRR), upward regulation.\n\n- **afrr_down** — aFRR, downward regulation.\n\n- **afrr_net** — aFRR, both directions in one signed series.\n\n- **mfrr_up** — Manual frequency restoration reserve (mFRR), upward regulation.\n\n- **mfrr_down** — mFRR, downward regulation.\n\n- **mfrr_net** — mFRR, both directions in one signed series.\n\n- **redispatch_up** — Redispatch, upward regulation.\n\n- **redispatch_down** — Redispatch, downward regulation.\n\n- **redispatch_net** — Redispatch, both directions in one signed series.\n\n- **other_up** — A different adjustment class, upward. The market's own code for the class is in the market dimensions.\n\n- **other_down** — A different adjustment class, downward. The market's own code for the class is in the market dimensions.\n\n- **other_net** — A different adjustment class, both directions in one signed series. The market's own code for the class is in the market dimensions.","enum":["ALL","afrr_up","afrr_down","afrr_net","mfrr_up","mfrr_down","mfrr_net","redispatch_up","redispatch_down","redispatch_net","other_up","other_down","other_net"],"examples":["ALL"],"title":"ImbalanceComponentValue","type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Component Value","description":"Component values to read. Omit to read every value.","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Component Value","description":"Component values to read. Omit to read every value.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[] | null"}},"faa068d9-61c5-486b-88f6-2fef3d091e15":{"description":"Market dimensions to filter by, as key:value. A market dimension is the market's own key and code for an imbalance series, for example the code of an adjustment class. A series matches when it has 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 for an imbalance series, for example the code of an adjustment class. A series matches when it has 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 for an imbalance series, for example the code of an adjustment class. A series matches when it has every pair.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"}}},"responses":{"8d2846a8-1e46-44d1-8021-02ef11630896":{"content":{"application/json":{"schema":{"properties":{"values":{"items":{"description":"An imbalance volume for one imbalance series and one Imbalance Settlement Period (ISP).","properties":{"external_id":{"description":"The identifier of the imbalance series. The market gives it, or Engrate gives it in markets that do not give a stable identifier.","title":"External Id","type":"string","isRequired":true,"uniqueKey":"values.items.[INDEX].external_id","typeLabel":"string"},"finality":{"description":"The settlement run of an imbalance. Each market has its own names for its runs, and all of them map to this common ladder. When one settlement period has more than one record, use the record with the highest finality, then the latest `stated_at`. When records have the same values in both fields, use the first of them in the response.\n\n### Available imbalance finalities\n\n- **preliminary** — The first run, before the market has all the data.\n\n- **revised** — A run that corrects the preliminary data.\n\n- **final** — The run used for settlement and invoicing.\n\n- **correction** — A run that corrects a wrong final value. A correction replaces the final value.","enum":["preliminary","revised","final","correction"],"examples":["final"],"title":"ImbalanceFinality","type":"string","isRequired":true,"uniqueKey":"values.items.[INDEX].finality","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>"},"stated_at":{"description":"The market's own timestamp for the settlement run of the record, as an ISO 8601 timestamp in UTC.","format":"date-time","title":"Stated At","type":"string","isRequired":true,"uniqueKey":"values.items.[INDEX].stated_at","typeLabel":"string\u003cdate-time>"},"volume_wh":{"description":"The signed volume in Wh. On a total, a positive volume means that the balance group was long: it injected more, or withdrew less, than its trade schedule. On an adjustment, the sign is its effect on the imbalance: positive makes the balance group longer.","examples":[-1250000],"title":"Volume Wh","type":"integer","isRequired":true,"uniqueKey":"values.items.[INDEX].volume_wh","typeLabel":"integer"}},"required":["external_id","finality","isp_resolution_minutes","isp_time","known_at","stated_at","volume_wh"],"title":"ImbalanceRecord","type":"object","uniqueKey":"values.items.[INDEX]","typeLabel":"ImbalanceRecord · object"},"title":"Values","type":"array","isRequired":true,"uniqueKey":"values","typeLabel":"ImbalanceRecord · object[]"}},"required":["values"],"title":"ImbalancesResponse","type":"object","uniqueKey":"","typeLabel":"ImbalancesResponse · object"},"examples":{"Example":{"title":"Example","value":{"values":[{"external_id":"\u003cstring>","finality":"final","isp_resolution_minutes":123,"isp_time":"2026-09-26T22:00:00Z","known_at":"2023-11-07T05:31:56Z","stated_at":"2023-11-07T05:31:56Z","volume_wh":-1250000}]}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"7d55f8e7-bf1a-4472-bbe7-bc3d183a642c":{"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":{"97dd253d-026b-47d1-8ac4-7d4d04c3064e":{"apiKeyAuth":{"in":"header","name":"Authorization","type":"apiKey","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"2219c5a9-9f66-4c8c-9e40-d681b2196046":{"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 Imbalances - Engrate Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T14:23:57.493Z","originalFileLocation":"api-reference/timeseries/list-imbalances.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 the imbalance volumes that agree with the filters. Each imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. On a total, a positive volume means that the balance group was long. On an adjustment, a positive volume makes the balance group longer. This can return more than one record per ISP for one imbalance series. Use the record with the highest finality, then the latest stated_at. When records have the same values in both fields, use the first of them in the response. The total includes its adjustments, and the net adjustment includes the adjustment classes. Do not add volumes across these levels. The API gives the status code 422 in these conditions: - isp_from or isp_until is missing, or it has no time zone offset. - A market_dimension filter is not in the format key:value. - A market_dimension filter has one key two times. - A component_kind or component_value filter has an unknown value. - An external_id, scheduling_area, balance_group or market_dimension filter exceeds its maximum number of values.\">\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 Imbalances - Engrate Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"List the imbalance volumes that agree with the filters. Each imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. On a total, a positive volume means that the balance group was long. On an adjustment, a positive volume makes the balance group longer. This can return more than one record per ISP for one imbalance series. Use the record with the highest finality, then the latest stated_at. When records have the same values in both fields, use the first of them in the response. The total includes its adjustments, and the net adjustment includes the adjustment classes. Do not add volumes across these levels. The API gives the status code 422 in these conditions: - isp_from or isp_until is missing, or it has no time zone offset. - A market_dimension filter is not in the format key:value. - A market_dimension filter has one key two times. - A component_kind or component_value filter has an unknown value. - An external_id, scheduling_area, balance_group or market_dimension filter exceeds its maximum number of values.\">\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-imbalances\">\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+Imbalances\u0026amp;description=List+the+imbalance+volumes+that+agree+with+the+filters.%0A%0AEach+imbalance+series+holds+the+imbalance+of+one+balance+group+in+one+scheduling+area%2C+or+one+adjustmen\u0026amp;theme=afa5e8a3bcc00498066c4a3e\u0026amp;signature=770f8302098db9a75b04e5b6005139e2ddab415c77a3f4af2e3c16a9a2d76adb\">\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 Imbalances - Engrate Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List the imbalance volumes that agree with the filters. Each imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. On a total, a positive volume means that the balance group was long. On an adjustment, a positive volume makes the balance group longer. This can return more than one record per ISP for one imbalance series. Use the record with the highest finality, then the latest stated_at. When records have the same values in both fields, use the first of them in the response. The total includes its adjustments, and the net adjustment includes the adjustment classes. Do not add volumes across these levels. The API gives the status code 422 in these conditions: - isp_from or isp_until is missing, or it has no time zone offset. - A market_dimension filter is not in the format key:value. - A market_dimension filter has one key two times. - A component_kind or component_value filter has an unknown value. - An external_id, scheduling_area, balance_group or market_dimension filter exceeds its maximum number of values.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://engrate.mintlify.app/_mintlify/api/og/v2?division=Allocations\u0026amp;title=List+Imbalances\u0026amp;description=List+the+imbalance+volumes+that+agree+with+the+filters.%0A%0AEach+imbalance+series+holds+the+imbalance+of+one+balance+group+in+one+scheduling+area%2C+or+one+adjustmen\u0026amp;theme=afa5e8a3bcc00498066c4a3e\u0026amp;signature=770f8302098db9a75b04e5b6005139e2ddab415c77a3f4af2e3c16a9a2d76adb\">\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-imbalances\">\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-imbalances.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-imbalances#webpage\",\"url\":\"https://docs.engrate.io/api-reference/timeseries/list-imbalances\",\"name\":\"List Imbalances\",\"description\":\"List the imbalance volumes that agree with the filters. Each imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. On a total, a positive volume means that the balance group was long. On an adjustment, a positive volume makes the balance group longer. This can return more than one record per ISP for one imbalance series. Use the record with the highest finality, then the latest stated_at. When records have the same values in both fields, use the first of them in the response. The total includes its adjustments, and the net adjustment includes the adjustment classes. Do not add volumes across these levels. The API gives the status code 422 in these conditions: - isp_from or isp_until is missing, or it has no time zone offset. - A market_dimension filter is not in the format key:value. - A market_dimension filter has one key two times. - A component_kind or component_value filter has an unknown value. - An external_id, scheduling_area, balance_group or market_dimension filter exceeds its maximum number of values.\",\"dateModified\":\"2026-11-03T14:23:57.493Z\",\"isPartOf\":{\"@id\":\"https://docs.engrate.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.engrate.io/api-reference/timeseries/list-imbalances#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.engrate.io/api-reference/timeseries/list-imbalances#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 Imbalances\",\"item\":\"https://docs.engrate.io/api-reference/timeseries/list-imbalances\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.engrate.io/api-reference/timeseries/list-imbalances#apireference\",\"headline\":\"List Imbalances\",\"name\":\"List Imbalances\",\"description\":\"List the imbalance volumes that agree with the filters. Each imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. On a total, a positive volume means that the balance group was long. On an adjustment, a positive volume makes the balance group longer. This can return more than one record per ISP for one imbalance series. Use the record with the highest finality, then the latest stated_at. When records have the same values in both fields, use the first of them in the response. The total includes its adjustments, and the net adjustment includes the adjustment classes. Do not add volumes across these levels. The API gives the status code 422 in these conditions: - isp_from or isp_until is missing, or it has no time zone offset. - A market_dimension filter is not in the format key:value. - A market_dimension filter has one key two times. - A component_kind or component_value filter has an unknown value. - An external_id, scheduling_area, balance_group or market_dimension filter exceeds its maximum number of values.\",\"url\":\"https://docs.engrate.io/api-reference/timeseries/list-imbalances\",\"mainEntityOfPage\":{\"@id\":\"https://docs.engrate.io/api-reference/timeseries/list-imbalances#webpage\"},\"dateModified\":\"2026-11-03T14:23:57.493Z\",\"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":"Core","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":[{"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"}]},{"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":"Confirmed schedules","tag":"ALPHA","href":"/api-reference/schedule-management/confirmed-schedules"},{"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"},{"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":"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":"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":"Imbalance record","href":"/api-reference/allocations/models/imbalance-record"},{"title":"Imbalance series","href":"/api-reference/allocations/models/imbalance-series"}]},{"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","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"},{"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","description":"List the imbalance series that agree with the filters.\n\nEach imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. Use its `external_id` to read its volumes in List Imbalances.\n\nThe list shows the imbalance series in the sequence of `external_id`. To read the full list, use `offset` and `limit` to get one page at a time. `total` is the number of imbalance series that agree with the filters, on all pages.\n\nThe API gives the status code 422 in these conditions:\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 `component_kind` or `component_value` filter has an unknown value.\n\n- An `external_id`, `scheduling_area`, `balance_group` or `market_dimension` 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/imbalance","href":"/api-reference/timeseries/list-imbalance-series"}]}]},{"group":"Portfolio Forecasts","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"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/product-updates"}]}]},"basePath":"","title":"List Imbalances - Engrate Developer Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}