{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Errors","type":"basic","slug":"errors","excerpt":"The Open Exchange Rates API will return JSON error messages if something goes wrong, to help you debug your applications and raise alerts.","body":"All Open Exchange Rates API errors currently use the same format.\n\nHere's an example, produced when an invalid `app_id` is provided:\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"error\\\": true,\\n \\\"status\\\": 401,\\n \\\"message\\\": \\\"invalid_app_id\\\",\\n \\\"description\\\": \\\"Invalid App ID provided - please sign up at https://openexchangerates.org/signup, or contact support:::at:::openexchangerates.org.\\\"\\n}\",\n \"language\": \"json\"\n }\n ]\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Error Status Codes Reference\"\n}\n[/block]\nThere are several potential errors, the most common listed below:\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Message\",\n \"h-1\": \"Status Code\",\n \"h-2\": \"Details\",\n \"h-3\": \"Example\",\n \"0-0\": \"\\\"not_found\\\"\",\n \"1-0\": \"\\\"missing_app_id\\\"\",\n \"2-0\": \"\\\"invalid_app_id\\\"\",\n \"3-0\": \"\\\"not_allowed\\\"\",\n \"4-0\": \"\\\"access_restricted\\\"\",\n \"5-0\": \"\\\"invalid_base\\\"\",\n \"0-1\": \"404\",\n \"1-1\": \"401\",\n \"2-1\": \"401\",\n \"3-1\": \"429\",\n \"4-1\": \"403\",\n \"5-1\": \"400\",\n \"5-2\": \"Client requested rates for an unsupported base currency\",\n \"4-2\": \"Access restricted for repeated over-use (status: 429), or other reason given in ‘description’ (403).\",\n \"3-2\": \"Client doesn’t have permission to access requested route/feature\",\n \"2-2\": \"Client provided an invalid App ID\",\n \"1-2\": \"Client did not provide an App ID\",\n \"0-2\": \"Client requested a non-existent resource/route\"\n },\n \"cols\": 3,\n \"rows\": 6\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"\",\n \"body\": \"If you get an error that is not documented here, or experience some other issue with the API, please contact us.\"\n}\n[/block]","updates":["59ec81853551d0001a3344b7","59ec81f573b8560010f44c4e","60b91bfeedeb38002ae26ae2","60ca0a553dbf1f00719e84d1"],"order":4,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"566b84833113f30d009587ea","__v":6,"project":"55312174c68f493900aebb3f","version":{"version":"0.7","version_clean":"0.7.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["55312175c68f493900aebb43","566b431d03b4b20d00d02c3a","566b58f212bc0517005d3068","566b59110506f40d0034f148","566b7cc94d1a4d0d00801c00","566b82d130cdb417008d217d","566b855b4d1a4d0d00801c04","566b856f03870a0d008ee7a7","566c42d2f0a5dc0d009acbab","566c443d85dc790d0062c134"],"_id":"55312174c68f493900aebb42","project":"55312174c68f493900aebb3f","releaseDate":"2015-04-17T15:06:28.598Z","__v":10,"createdAt":"2015-04-17T15:06:28.598Z"},"githubsync":"","user":"5531215e29603d2300011341","category":{"sync":{"isSync":false,"url":""},"pages":["55312175c68f493900aebb45","566bf164737e260d00c698de","566bf46e737e260d00c698e1","566bf708cb3d040d00abae1f"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":true,"_id":"55312175c68f493900aebb43","__v":4,"createdAt":"2015-04-17T15:06:29.145Z","version":"55312174c68f493900aebb42","project":"55312174c68f493900aebb3f"},"createdAt":"2015-12-12T02:20:51.468Z","parentDoc":null}
Errors
The Open Exchange Rates API will return JSON error messages if something goes wrong, to help you debug your applications and raise alerts.