{"source":"norgesbank","operation":"get_series","description":"Fetch one or more time series from any Norges Bank dataflow.","parameters":[{"name":"dataset_id","schema":{"type":"string"},"required":true,"default":null,"description":"A Norges Bank dataflow id, e.g. \"EXR\" (see list_datasets())."},{"name":"key","schema":{"type":"string"},"required":true,"default":null,"description":"Dot-joined dimension codes in key order, e.g. \"B.USD.NOK.SP\". Leave a segment empty for \"all values\" on that dimension, e.g. \"B..NOK.SP\" for every currency's spot rate. Get valid codes and their order from get_dataset_dimensions()."},{"name":"start_period","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Optional earliest date/period to include, \"YYYY-MM-DD\" (or \"YYYY\", \"YYYY-Qn\", depending on the dataflow's frequency)."},{"name":"end_period","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Optional latest date/period to include."},{"name":"last_n_observations","schema":{"anyOf":[{"type":"integer"},{"type":"null"}]},"required":false,"default":null,"description":"Optional cap returning only the most recent N observations per series - handy instead of a date range. With neither a date range nor this set, only the most recent 30 per series are returned by default (a `note` in the response says so); pass a value for more history."},{"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)."},{"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."}],"json_get_url_template":"https://allemannsdata.com/wiki/api/v1/kilder/norgesbank/get_series?dataset_id={dataset_id}&key={key}&start_period={start_period}&end_period={end_period}&last_n_observations={last_n_observations}&limit=25&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"dataset_id":{"type":["string","null"]},"key":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"series":{"type":"array","items":{"type":"object","properties":{"dimensions":{"type":"object","additionalProperties":{"type":"object","properties":{"code":{"type":["string","null"]},"label":{"type":["string","null"]}},"additionalProperties":false}},"observations":{"type":"array","items":{"anyOf":[{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},{"type":"object","properties":{"period":{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},"value":{"anyOf":[{"x-allemannsdata-schema-status":"unresolved","description":"Response shape is not yet declared; any JSON value is permitted."},{"type":"number"}]}},"additionalProperties":false}]}}},"additionalProperties":false}},"truncated":{"type":"boolean"},"note":{"type":"string"}},"additionalProperties":false},"response_schema_status":{"status":"incomplete","codegen_safe":false,"description":"Not suitable for typed model generation: the container shape and field names are useful, but unresolved values accept any JSON value."},"entity_projection":{"status":"projected","entity_types":["economic_dataset"],"description":"Recognized records and stable operation identifiers are projected; an empty array means the successful payload contained no recognizable entity."},"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"}},"required":["self","api_index"],"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/norgesbank/get_series/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/norgesbank/get_series","source":"https://allemannsdata.com/wiki/api/v1/kilder/norgesbank"},"output_fields":["dataset_id","key","series","series[].dimensions","series[].observations","series[].observations[].period","series[].observations[].value","truncated","note"],"output_fields_truncated":false,"canonical_field_aliases":{}}