To see our repository on GitHub visit here.
Data we supply is derived from a collection of publicly-available third-party sources – World Bank, United Nations, Freedom House, etc. -- about the state of countries around the world. For instance, you can use our API to determine maternal mortality rates in a particular country, or to find out how many people in a set of countries have access to credit.
You can retreive all kinds of data pertaining to categories, countries, indicators, and regions. With the data you want from each country and region you can then retreive data value for each indicator you specify and for which year or years.
Our API can handle many types of GET requests that will return a broad range of public data. However you want to requests and retreive that data will be based on the parameters you pass through the URL. Each endpoint we have provided will allow you to pass through specific fields and value in query string format. For each end point here are the fields the endpoint looks for:
- categories/?category=<value1>&subcategory=<value2>
- countries/?country=<value1>
- countries/data/?country<value1>&indicator<value2>&year=<value3>
- indicators/?indicator=<value1>
- regions/?region=<value1>
- regions/data/?region=<value1>&indicator=<value2>&year=<value3>
A quick thing to note is that when you are requesting multiple values for a specific field in the URL you must use a | (pipe).
This will allow you to GET multiple countries /?country=<value1>|<value2>, etc. Also note that when you are requesting the endpoints
at countries/data/ and regions/data/ to get data for all the years you do not need to specify a year field - it will default to 'all'.
You also do not need to enter a category or subcategory based on what kind of data you want to get back. (You can request categories and/or subcategories)
categories/
list/
- fields : category (category name), subcategory (subcategory name)
countries/
list/
- fields : country (subcountry name)
countries/data/
- fields : country (country id), indicator (indicator id), year (valid 4 digit year)
indicators/
list/
- fields : indicator (indicator name)
regions/
list/
- fields : region (region name)
region/data/
- fields : region (region id), indicator (indicator id), year (valid 4 digit year)
To register an account and receive a token you must first go to the Sign Up page and enter a requested username, your email, and a password for your account.
Once you sign up you will receive a temporary token; you will also receive a verification email.
To verify your account go to the Verify Email page from the Account dropdown menu.
Once you have verified your account you can then create a token on the Create Token page under the dropdown menu using your credentials.
After you successfully entered your credentials you will see a token that is unique to your account. This token will expire in 90 days - to get a new token you can either refresh your token or you can create a new one again with your credentials.
If you forgot your password to request a password change you can click the Forgot Password link on the Create Token page.
To change your password when you have your registered Token you must go to the Change Password link from the dropdown menu. To update your password you must have your valid Token and enter and confirm a new password.
To update your account information you must have your valid Token. Once you have your token you go to the Account Details page and enter your token. After you enter your token you must "Retreive Account Information" - this will auto fill the fields with your current information. You can then change it to valid information and then Save your updated information.