> For the complete documentation index, see [llms.txt](https://apidocs.arionbanki.is/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.arionbanki.is/open-data/api-reference/currencies.md). # Currencies Download OpenAPI yaml file ## Read list of currencies. > Retrieve a list of all available currencies by source. ```json {"openapi":"3.0.4","info":{"title":"Open Data Currency Api","version":"v1"},"tags":[{"name":"Currencies","description":"IOBWS 3.0 Currency Information Service."}],"servers":[{"url":"https://apigw.arionbanki.is/currency"}],"security":[{"Curity":["openid"]}],"components":{"securitySchemes":{"Curity":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://apigw.arionbanki.is/oauth/v2/oauth-token","scopes":{}}}}},"schemas":{"IobwsCurrenciesResponse":{"type":"object","properties":{"currencies":{"type":"array","items":{"$ref":"#/components/schemas/IobwsCurrency"},"description":"List of available currencies.","nullable":true}},"additionalProperties":false,"description":"Response returned by the IOBWS read-currencies endpoint."},"IobwsCurrency":{"type":"object","properties":{"currencyCode":{"type":"string","description":"ISO 4217 Alpha-3 currency code.","nullable":true},"description":{"type":"string","description":"Human-readable name of the currency.","nullable":true}},"additionalProperties":false,"description":"Currency entry returned by the IOBWS currencies list endpoint."},"IobwsErrorResponse":{"type":"object","properties":{"svcMessages":{"type":"array","items":{"$ref":"#/components/schemas/IobwsServiceMessage"},"description":"List of service messages describing the error(s).","nullable":true}},"additionalProperties":false,"description":"Standardised IOBWS error response body."},"IobwsServiceMessage":{"type":"object","properties":{"category":{"type":"string","description":"Message category: \"ERROR\" or \"WARNING\".","nullable":true},"code":{"type":"string","description":"IOBWS-defined message code (e.g. \"FORMAT_ERROR\").","nullable":true},"path":{"type":"string","description":"Optional path to the field that caused the error.","nullable":true},"text":{"type":"string","description":"Optional human-readable description of the error.","nullable":true}},"additionalProperties":false,"description":"A single service message in an IOBWS error response."},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/currencies":{"get":{"tags":["Currencies"],"summary":"Read list of currencies.","description":"Retrieve a list of all available currencies by source.","parameters":[{"name":"currencySourceQuery","in":"query","description":"Currency source filter.","schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique request identifier (UUID). Required.","required":true,"schema":{"type":"string"}},{"name":"USR-IP-Address","in":"header","description":"Forwarded end-user IP address. Optional.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of currencies.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/IobwsCurrenciesResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/IobwsCurrenciesResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/IobwsCurrenciesResponse"}}}},"400":{"description":"Invalid request parameters.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}}}}}} ``` ## Read list of currency sources. > Retrieve all supported currency sources. ```json {"openapi":"3.0.4","info":{"title":"Open Data Currency Api","version":"v1"},"tags":[{"name":"Currencies","description":"IOBWS 3.0 Currency Information Service."}],"servers":[{"url":"https://apigw.arionbanki.is/currency"}],"security":[{"Curity":["openid"]}],"components":{"securitySchemes":{"Curity":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://apigw.arionbanki.is/oauth/v2/oauth-token","scopes":{}}}}},"schemas":{"IobwsCurrencySourcesResponse":{"type":"object","properties":{"currencySources":{"type":"array","items":{"$ref":"#/components/schemas/IobwsCurrencySource"},"description":"List of available currency sources.","nullable":true}},"additionalProperties":false,"description":"Response returned by the IOBWS read-currency-sources endpoint."},"IobwsCurrencySource":{"type":"object","properties":{"sourceName":{"type":"string","description":"Name of the currency source (e.g. \"General\", \"Notes\").","nullable":true}},"additionalProperties":false,"description":"Currency source entry returned by the IOBWS sources endpoint."},"IobwsErrorResponse":{"type":"object","properties":{"svcMessages":{"type":"array","items":{"$ref":"#/components/schemas/IobwsServiceMessage"},"description":"List of service messages describing the error(s).","nullable":true}},"additionalProperties":false,"description":"Standardised IOBWS error response body."},"IobwsServiceMessage":{"type":"object","properties":{"category":{"type":"string","description":"Message category: \"ERROR\" or \"WARNING\".","nullable":true},"code":{"type":"string","description":"IOBWS-defined message code (e.g. \"FORMAT_ERROR\").","nullable":true},"path":{"type":"string","description":"Optional path to the field that caused the error.","nullable":true},"text":{"type":"string","description":"Optional human-readable description of the error.","nullable":true}},"additionalProperties":false,"description":"A single service message in an IOBWS error response."},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/currencies/sources":{"get":{"tags":["Currencies"],"summary":"Read list of currency sources.","description":"Retrieve all supported currency sources.","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique request identifier (UUID). Required.","required":true,"schema":{"type":"string"}},{"name":"USR-IP-Address","in":"header","description":"Forwarded end-user IP address. Optional.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of currency sources.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/IobwsCurrencySourcesResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/IobwsCurrencySourcesResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/IobwsCurrencySourcesResponse"}}}},"400":{"description":"Invalid request parameters.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}}}}}} ``` ## Read rates for a base currency. > Read currency rates for a given base currency. ```json {"openapi":"3.0.4","info":{"title":"Open Data Currency Api","version":"v1"},"tags":[{"name":"Currencies","description":"IOBWS 3.0 Currency Information Service."}],"servers":[{"url":"https://apigw.arionbanki.is/currency"}],"security":[{"Curity":["openid"]}],"components":{"securitySchemes":{"Curity":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://apigw.arionbanki.is/oauth/v2/oauth-token","scopes":{}}}}},"schemas":{"IobwsCurrencyRatesResponse":{"type":"object","properties":{"currencyRates":{"type":"array","items":{"$ref":"#/components/schemas/IobwsCurrencyRate"},"description":"List of currency rates.","nullable":true}},"additionalProperties":false,"description":"Response returned by the IOBWS currency-rates endpoints."},"IobwsCurrencyRate":{"type":"object","properties":{"baseCurrency":{"type":"string","description":"ISO 4217 code of the base currency (e.g. \"ISK\").","nullable":true},"quoteCurrency":{"type":"string","description":"ISO 4217 code of the quoted currency (e.g. \"EUR\").","nullable":true},"currencySource":{"$ref":"#/components/schemas/IobwsCurrencySource"},"buy":{"type":"string","description":"Buy rate as a decimal string.","nullable":true},"sell":{"type":"string","description":"Sell rate as a decimal string.","nullable":true},"date":{"type":"string","description":"Rate registration date in ISO 8601 date format (yyyy-MM-dd).","nullable":true}},"additionalProperties":false,"description":"A single currency rate entry in the IOBWS standard format."},"IobwsCurrencySource":{"type":"object","properties":{"sourceName":{"type":"string","description":"Name of the currency source (e.g. \"General\", \"Notes\").","nullable":true}},"additionalProperties":false,"description":"Currency source entry returned by the IOBWS sources endpoint."},"IobwsErrorResponse":{"type":"object","properties":{"svcMessages":{"type":"array","items":{"$ref":"#/components/schemas/IobwsServiceMessage"},"description":"List of service messages describing the error(s).","nullable":true}},"additionalProperties":false,"description":"Standardised IOBWS error response body."},"IobwsServiceMessage":{"type":"object","properties":{"category":{"type":"string","description":"Message category: \"ERROR\" or \"WARNING\".","nullable":true},"code":{"type":"string","description":"IOBWS-defined message code (e.g. \"FORMAT_ERROR\").","nullable":true},"path":{"type":"string","description":"Optional path to the field that caused the error.","nullable":true},"text":{"type":"string","description":"Optional human-readable description of the error.","nullable":true}},"additionalProperties":false,"description":"A single service message in an IOBWS error response."},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/currencies/{baseCurrency}/rates":{"get":{"tags":["Currencies"],"summary":"Read rates for a base currency.","description":"Read currency rates for a given base currency.","parameters":[{"name":"baseCurrency","in":"path","description":"ISO 4217 base currency code (e.g. \"ISK\").","required":true,"schema":{"type":"string"}},{"name":"currencySourceQuery","in":"query","description":"Currency source filter.","schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique request identifier (UUID). Required.","required":true,"schema":{"type":"string"}},{"name":"USR-IP-Address","in":"header","description":"Forwarded end-user IP address. Optional.","schema":{"type":"string"}}],"responses":{"200":{"description":"Currency rates.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/IobwsCurrencyRatesResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/IobwsCurrencyRatesResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/IobwsCurrencyRatesResponse"}}}},"400":{"description":"Invalid request parameters.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}}}}}} ``` ## Reads rates for a quoted currency with a defined base currency. > Reads currency rates for a quoted currency, given a defined base currency. ```json {"openapi":"3.0.4","info":{"title":"Open Data Currency Api","version":"v1"},"tags":[{"name":"Currencies","description":"IOBWS 3.0 Currency Information Service."}],"servers":[{"url":"https://apigw.arionbanki.is/currency"}],"security":[{"Curity":["openid"]}],"components":{"securitySchemes":{"Curity":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://apigw.arionbanki.is/oauth/v2/oauth-token","scopes":{}}}}},"schemas":{"IobwsCurrencyRatesResponse":{"type":"object","properties":{"currencyRates":{"type":"array","items":{"$ref":"#/components/schemas/IobwsCurrencyRate"},"description":"List of currency rates.","nullable":true}},"additionalProperties":false,"description":"Response returned by the IOBWS currency-rates endpoints."},"IobwsCurrencyRate":{"type":"object","properties":{"baseCurrency":{"type":"string","description":"ISO 4217 code of the base currency (e.g. \"ISK\").","nullable":true},"quoteCurrency":{"type":"string","description":"ISO 4217 code of the quoted currency (e.g. \"EUR\").","nullable":true},"currencySource":{"$ref":"#/components/schemas/IobwsCurrencySource"},"buy":{"type":"string","description":"Buy rate as a decimal string.","nullable":true},"sell":{"type":"string","description":"Sell rate as a decimal string.","nullable":true},"date":{"type":"string","description":"Rate registration date in ISO 8601 date format (yyyy-MM-dd).","nullable":true}},"additionalProperties":false,"description":"A single currency rate entry in the IOBWS standard format."},"IobwsCurrencySource":{"type":"object","properties":{"sourceName":{"type":"string","description":"Name of the currency source (e.g. \"General\", \"Notes\").","nullable":true}},"additionalProperties":false,"description":"Currency source entry returned by the IOBWS sources endpoint."},"IobwsErrorResponse":{"type":"object","properties":{"svcMessages":{"type":"array","items":{"$ref":"#/components/schemas/IobwsServiceMessage"},"description":"List of service messages describing the error(s).","nullable":true}},"additionalProperties":false,"description":"Standardised IOBWS error response body."},"IobwsServiceMessage":{"type":"object","properties":{"category":{"type":"string","description":"Message category: \"ERROR\" or \"WARNING\".","nullable":true},"code":{"type":"string","description":"IOBWS-defined message code (e.g. \"FORMAT_ERROR\").","nullable":true},"path":{"type":"string","description":"Optional path to the field that caused the error.","nullable":true},"text":{"type":"string","description":"Optional human-readable description of the error.","nullable":true}},"additionalProperties":false,"description":"A single service message in an IOBWS error response."},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/currencies/{quoteCurrency}/rates/{baseCurrency}":{"get":{"tags":["Currencies"],"summary":"Reads rates for a quoted currency with a defined base currency.","description":"Reads currency rates for a quoted currency, given a defined base currency.","parameters":[{"name":"quoteCurrency","in":"path","description":"ISO 4217 quote currency code (e.g. \"EUR\").","required":true,"schema":{"type":"string"}},{"name":"baseCurrency","in":"path","description":"ISO 4217 base currency code (e.g. \"ISK\").","required":true,"schema":{"type":"string"}},{"name":"currencySourceQuery","in":"query","description":"Currency source filter.","schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique request identifier (UUID). Required.","required":true,"schema":{"type":"string"}},{"name":"USR-IP-Address","in":"header","description":"Forwarded end-user IP address. Optional.","schema":{"type":"string"}}],"responses":{"200":{"description":"Currency rate.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/IobwsCurrencyRatesResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/IobwsCurrencyRatesResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/IobwsCurrencyRatesResponse"}}}},"400":{"description":"Invalid request parameters.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}}}}}} ``` ## Read rates history for a currency pair. > Read historical currency rates for a quoted currency with a defined base currency. ```json {"openapi":"3.0.4","info":{"title":"Open Data Currency Api","version":"v1"},"tags":[{"name":"Currencies","description":"IOBWS 3.0 Currency Information Service."}],"servers":[{"url":"https://apigw.arionbanki.is/currency"}],"security":[{"Curity":["openid"]}],"components":{"securitySchemes":{"Curity":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://apigw.arionbanki.is/oauth/v2/oauth-token","scopes":{}}}}},"schemas":{"IobwsCurrencyRatesResponse":{"type":"object","properties":{"currencyRates":{"type":"array","items":{"$ref":"#/components/schemas/IobwsCurrencyRate"},"description":"List of currency rates.","nullable":true}},"additionalProperties":false,"description":"Response returned by the IOBWS currency-rates endpoints."},"IobwsCurrencyRate":{"type":"object","properties":{"baseCurrency":{"type":"string","description":"ISO 4217 code of the base currency (e.g. \"ISK\").","nullable":true},"quoteCurrency":{"type":"string","description":"ISO 4217 code of the quoted currency (e.g. \"EUR\").","nullable":true},"currencySource":{"$ref":"#/components/schemas/IobwsCurrencySource"},"buy":{"type":"string","description":"Buy rate as a decimal string.","nullable":true},"sell":{"type":"string","description":"Sell rate as a decimal string.","nullable":true},"date":{"type":"string","description":"Rate registration date in ISO 8601 date format (yyyy-MM-dd).","nullable":true}},"additionalProperties":false,"description":"A single currency rate entry in the IOBWS standard format."},"IobwsCurrencySource":{"type":"object","properties":{"sourceName":{"type":"string","description":"Name of the currency source (e.g. \"General\", \"Notes\").","nullable":true}},"additionalProperties":false,"description":"Currency source entry returned by the IOBWS sources endpoint."},"IobwsErrorResponse":{"type":"object","properties":{"svcMessages":{"type":"array","items":{"$ref":"#/components/schemas/IobwsServiceMessage"},"description":"List of service messages describing the error(s).","nullable":true}},"additionalProperties":false,"description":"Standardised IOBWS error response body."},"IobwsServiceMessage":{"type":"object","properties":{"category":{"type":"string","description":"Message category: \"ERROR\" or \"WARNING\".","nullable":true},"code":{"type":"string","description":"IOBWS-defined message code (e.g. \"FORMAT_ERROR\").","nullable":true},"path":{"type":"string","description":"Optional path to the field that caused the error.","nullable":true},"text":{"type":"string","description":"Optional human-readable description of the error.","nullable":true}},"additionalProperties":false,"description":"A single service message in an IOBWS error response."},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/currencies/{quoteCurrency}/rates/{baseCurrency}/history":{"get":{"tags":["Currencies"],"summary":"Read rates history for a currency pair.","description":"Read historical currency rates for a quoted currency with a defined base currency.","parameters":[{"name":"quoteCurrency","in":"path","description":"ISO 4217 quote currency code (e.g. \"EUR\").","required":true,"schema":{"type":"string"}},{"name":"baseCurrency","in":"path","description":"ISO 4217 base currency code (e.g. \"ISK\").","required":true,"schema":{"type":"string"}},{"name":"currencySourceQuery","in":"query","description":"Currency source filter.","schema":{"type":"string"}},{"name":"dateFrom","in":"query","description":"Start date (inclusive) in yyyy-MM-dd format.","schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"End date (inclusive) in yyyy-MM-dd format. Defaults to today.","schema":{"type":"string","format":"date-time"}},{"name":"X-Request-ID","in":"header","description":"Unique request identifier (UUID). Required.","required":true,"schema":{"type":"string"}},{"name":"USR-IP-Address","in":"header","description":"Forwarded end-user IP address. Optional.","schema":{"type":"string"}}],"responses":{"200":{"description":"Historical currency rates.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/IobwsCurrencyRatesResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/IobwsCurrencyRatesResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/IobwsCurrencyRatesResponse"}}}},"400":{"description":"Invalid request parameters.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/IobwsErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}}}}}} ```