{"source":"elhub","operation":"get_exchange","description":"Get measured electricity exchange (kWh) between one price area and each\nof its neighbours, hourly or summed per day. Signature: get_exchange(price_area: string, required; start_date: string, optional, default None; end_date: string, optional, default None; resolution: string, optional, default 'day'; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0).","signature":"get_exchange(price_area: string, required; start_date: string, optional, default None; end_date: string, optional, default None; resolution: string, optional, default 'day'; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0)","parameters":[{"name":"price_area","type":"string","schema":{"type":"string"},"required":true,"default":null,"description":"NO1..NO5 (required).","unit":null},{"name":"start_date","type":"string","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"First day, YYYY-MM-DD (default: 7 days before end_date).","unit":null},{"name":"end_date","type":"string","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Day after the last day wanted (exclusive), YYYY-MM-DD (default: today). At most one month per call.","unit":null},{"name":"resolution","type":"string","schema":{"type":"string"},"required":false,"default":"day","description":"\"day\" (default) sums per neighbour per local date; \"hour\" returns the raw hourly rows.","unit":null},{"name":"limit","type":"integer","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"display_type":"integer","required":false,"default":25,"description":"Maximum list items returned by the gateway (default 25, maximum 100).","unit":"items"},{"name":"offset","type":"integer","schema":{"type":"integer","minimum":0,"default":0},"display_type":"integer","required":false,"default":0,"description":"Number of list items to skip before returning the page.","unit":"items"}],"json_get_url_template":"https://allemannsdata.com/wiki/api/v1/kilder/elhub/get_exchange?price_area={price_area}&start_date={start_date}&end_date={end_date}&resolution=day&limit=25&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"dataset":{"type":"string"},"price_area":{"type":"string"},"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"resolution":{"type":"string"},"last_updated":{"type":["string","null"],"format":"date-time"},"total_import_kwh":{"type":"number"},"total_export_kwh":{"type":"number"},"net_import_kwh":{"type":"number"},"returned":{"type":"integer"},"truncated":{"type":"boolean"},"rows":{"type":"array","items":{"type":"object","properties":{"date":{"type":["string","null"],"format":"date"},"start_time":{"type":["string","null"],"format":"date-time"},"end_time":{"type":["string","null"],"format":"date-time"},"price_area":{"type":["string","null"]},"adjacent_area":{"type":["string","null"]},"exchange_in_kwh":{"type":["number","null"]},"exchange_out_kwh":{"type":["number","null"]},"net_import_kwh":{"type":["number","null"]}},"additionalProperties":false,"required":["price_area","adjacent_area","exchange_in_kwh","exchange_out_kwh","net_import_kwh"]}}},"additionalProperties":false,"required":["dataset","price_area","start_date","end_date","resolution","total_import_kwh","total_export_kwh","net_import_kwh","returned","truncated","rows"]},"response_schema_status":{"status":"declared","codegen_safe":true,"description":"Maintained response contract."},"entity_projection":{"status":"intentionally_none","entity_types":[],"description":"No stable cross-source entity projection is defined for this operation; entities is intentionally empty."},"error_contract":{"scope":"top-level HTTP error response; never part of a success payload","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object"}},"additionalProperties":false,"required":["code","message","retryable"]},"suggestion":{"type":"string"},"_meta":{"type":"object","properties":{"retrieved_at":{"type":"string","format":"date-time"},"language":{"type":"string","const":"en"},"content_languages":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"type":"object"}}},"required":["retrieved_at","language","content_languages","sources"]},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"api_index":{"type":"string","format":"uri"},"feedback":{"type":"string","format":"uri"}},"required":["self","api_index","feedback"],"additionalProperties":false}},"additionalProperties":false,"required":["error","suggestion","_meta","_links"]},"statuses":{"400":{"codes":["MISSING_PARAMETER","INVALID_PARAMETER","INVALID_REQUEST"],"retryable":false},"404":{"codes":["SOURCE_NOT_FOUND","OPERATION_NOT_FOUND","ENTITY_NOT_FOUND"],"retryable":false},"429":{"codes":["RATE_LIMITED","GATEWAY_RATE_LIMITED"],"retryable":true},"502":{"codes":["SOURCE_UNAVAILABLE"],"retryable":true},"500":{"codes":["INTERNAL_ERROR"],"retryable":true}}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/elhub/get_exchange","operation":"https://allemannsdata.com/wiki/api/v1/kilder/elhub/get_exchange","source":"https://allemannsdata.com/wiki/api/v1/kilder/elhub","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"},"output_fields":["dataset","price_area","start_date","end_date","resolution","last_updated","total_import_kwh","total_export_kwh","net_import_kwh","returned","truncated","rows","rows[].date","rows[].start_time","rows[].end_time","rows[].price_area","rows[].adjacent_area","rows[].exchange_in_kwh","rows[].exchange_out_kwh","rows[].net_import_kwh"],"output_fields_truncated":false,"canonical_field_aliases":{"date":["rows[].date"]},"response_example":{"source":"elhub","operation":"get_exchange","parameters":{"price_area":"example value","start_date":"2026-01-15","end_date":"2026-01-15","resolution":"day"},"data":{"dataset":"example value","price_area":"example value","start_date":"2026-01-15","end_date":"2026-01-15","resolution":"example value","last_updated":"2026-01-15T12:00:00Z","total_import_kwh":1.0,"total_export_kwh":1.0,"net_import_kwh":1.0,"returned":1,"truncated":true,"rows":[{"date":"2026-01-15","start_time":"2026-01-15T12:00:00Z","end_time":"2026-01-15T12:00:00Z","price_area":"example value","adjacent_area":"example value","exchange_in_kwh":1.0,"exchange_out_kwh":1.0,"net_import_kwh":1.0}]},"entities":[],"_meta":{"retrieved_at":"2026-01-15T12:00:00Z","language":"en","content_languages":["en"],"sources":[{"id":"elhub","name":"Elhub energy data","description":"Measured electricity consumption and production per price area, municipality and customer group, exchange between areas and installed capacity per source.","cache_ttl_seconds":3600,"documentation":"https://api.elhub.no/energy-data-api"}]},"_provenance":{"data":{"source":"elhub","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/elhub"},"entities":{"source":"elhub","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/elhub","derived_from":"#/data","description":"Normalized projection of data."}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/elhub/get_exchange","source":"https://allemannsdata.com/wiki/api/v1/kilder/elhub","wiki":"https://allemannsdata.com/wiki/kilder/elhub/get_exchange/","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"}}}
