API Databank Documentation
Technology Team
Oxford Economics
Getting an API key
To request an API key, please contact us using the Support platform. Eligibility for API provisioning depends on your organisation’s subscription. The key provided will be tied to a new, separate technical user account, which will maintain the same subscription profile as your organisation’s master account.
Alternatively, if you already have an account with access, you can use the login functionality of the /users endpoint to request your key directly. Read below more for information on endpoints.
Documentation contents
| Endpoints | Describes available endpoints and the examples on how to send the requests targeting specific endpoint | |
| Key Request Dictionaries and Request Header | Provides controller, selection, shape configuration and user credentials dictionaries | |
| Key Response Dictionaries | Provides download, selection and user dictionaries | |
| Conventions and Limits | Describes conventions, rate limits, page limits, authorization and variable access | |
| Downloading Entire Databanks | Describes the procedure on how to download entire databanks through API | |
| Redirects and CORS Restrictions | Information on how to deal with CORS restrictions in majority of web browsers | |
| Saved Selection to PowerBI through API | Describes the procedure on how to retrieve the saved selection to PowerBI through API | |
| Python GET request to retrieve a saved selection | Simple GET request example to retrieve the saved selection in Python dictionary | |
| Python POST request with customized request body | Simple POST request example to retrieve the selection indicated in the body of request |
Application examples
We have a full range of examples on Github that cover everything from C# and Python to Tableau and Microsoft Power BI.
You can also test out the full range of endpoints using the API Swagger, here, or our Postman collection, here.
