There is a fair amount of data available from the Malaysia Open Data website

It would be great if the number of domestic abuse cases be added to the API. The data itself can be obtained from here.

However, there might be some data missing or the information there might be incomplete. If so, these should be marked as "NA". Please note that the data should include the cases by each year. If the information doesn't exist, the information can be omitted.

Currently, it can be seen that, there is an entry at

https://github.com/JianLoong/malaysia-api/blob/main/state/v1/selangor.json which actually leads to this end point which is deployed via gh-pages.

So, a Negeri_Sembilan.json should be created which contains information with regards to the state Negeri Sembilan.

Information with regards to the state can be obtained here.

The JSON file should contain the information should have similar output with the Selangor.json. Please also remember that the JSON file should be valid. (Please use a JSON validator to ensure that it is a valid JSON file).

Currently the file at /state/v1/all.json only consist of 4 information per state. The information here should be more complete based on the Wikipedia entry here.

So, the all.json needs to be updated with the remaining information which includes, the population, total area, license plate prefix, phone area code, abbreviation, ISO, FIPS, HDI, region, head of state and the head of the government.

Currently, the flag and crest URLs of the various states point to the Wikipedia website entry. (Where the user can choose the download the SVG or PNG file).

This can be improved by adding the path to the image itself instead.

For example in the file state/v1/johor.json the

"flag_url" information is currenty

"https://en.wikipedia.org/wiki/Johor#/media/File:Flag_of_Johor.svg"

when it should be instead

"https://upload.wikimedia.org/wikipedia/commons/5/5a/Flag_of_Johor.svg"

This is the same as several other entries.

Besides that, several states are also missing this information including, Kedah, Kelantan and a few others.

Currently information regarding various states are incomplete.

For example, the results of the selangor.json here. is complete whereas the information for all other states like Johor is incomplete.

You can complete this by adding all the missing information in the specific JSON files.

Do remember to validate your JSON file to ensure it is valid.

Currently, this repository only holds a limited amount of information.

However, its features and contents can be significantly improved upon.

I am open to potential ideas as well as data fields or enhancements that can be made to the repository. Feel free to discuss it here. If that feature seems like a neat feature, I will open an issue for that specific feature.

Happy coding and hacktoberfest. 👍

Each state should have their own climate data. The climate data can be obtained in several ways.

1. The first way is to slowly comb through the available open data located here. and add the data to each of the state accordingly.

or the easier way

2. Use the climate data from the Wikipedia located here for Selangor.

The data for the climate should be able to clearly denote each year and month so that it is easily parsed.

Refer to here for each state and create a specific entry in the v1 directory.

Each state should have a complete entry and also their description.

For example, in this request, the accompanying description is also added in the data.

The current status of the end point are as follows.

x denotes the data entry is completed.

Edit - Updated information

Currently the information regarding all states it incomplete.

More information should be added so that the all end point would return all states.

Information can be gathered here

Currently the end point of it can be seen here

There is a fair amount of data available from the Malaysia Open Data website

It would be great if the unemployment data for each state could be added to the API. The data itself can be obtained from here. However, there might be some data missing or the information there might be incomplete.

It is not needed to add all the years to the API but just for the year 2020.

Currently there is an inconsistent naming convention with regards to the end points of the REST resources.

For example,

https://jianliew.me/malaysia-api/state/v1/selangor.json which uses a lowercase 's' leads to the that specific resource,

however, compared to

https://jianliew.me/malaysia-api/state/v1/Johor.json which uses an uppercase 'j' leads that resource and the

https://jianliew.me/malaysia-api/state/v1/johor.json leads to file not found.

Please note, that I would rather not use an url rewrite option. Changing all resources to use lower cases will be an easier fix. Please note that, you should also update the readme and etc so that the fix is consistent.

Currently, it can be seen that there is an entry at

https://github.com/JianLoong/malaysia-api/blob/main/state/v1/selangor.json which actually leads to this end point which deployed to gh-pages.

So, a Kedah.json should be created which contains information with regards to the state Kedah.

Information with regards to the state can be obtained here.

The JSON file should contain the information should have similar output with the Selangor.json. Please also remember that the JSON file should be valid. (Please use a JSON validator to ensure that it is a valid JSON file).

Edit - Fixed typos and grammar mistakes.

The forested area of each state can be obtained from the department of statistics website here. under the environment section.

This data should be included into each of the state information.

Previously in #1 , states have been added but the federal territories have not been added.

Based on the Wikipedia entry here, please add the 3 federal territories to the all.json file.

The administrative division should be "Federal Territory of x" where x is depending on the information found on Wikipedia.

Currently, it can be seen that, there is an entry at

https://github.com/JianLoong/malaysia-api/blob/main/state/v1/selangor.json which actually leads to this end point.

So, a Labuan.json should be created which contains information with regards to the state of Labuan.

Information with regards to the state can be obtained here.

This applies to Kuala Lumpur and Putrajaya as well.

The JSON files should contain the information should have similar output with the Selangor.json. Please also remember that the JSON file should be valid. (Please use a JSON validator to ensure that it is a valid JSON file).

Each state should have its own religion census data obtained from open source information.

Since, the data available is limited, the information should be stored in a sensible way taking into account the year and % breakdown. So, that it can be easily parsed.

The data for the state Negeri Sembilan can be obtained from the Wikipedia entry here.

Currently, all information is stored in the English language however, a more widely spoken language in Malaysia is Bahasa Malaysia or Bahasa Melayu. So, all entries should have a translated version in the national language itself.

All information with regards to the states can be found in the Wikipedia Bahasa Malaysia for example an entry for Selangor can be found here. essentially the BM entry of Wikipedia for the state of Selangor.

There are a few ways this can be approached either.

1. Create more directories for example using endpoints like /malaysia-api/state/v1/en/selangor.json to denote that it would be in the English language and /malaysia-api/state/v1/zsm/selangor.json to denote that it would be in Bahasa Malaysia. With zsm denoting that it is standard Malay as per ISO specification here.. Basically, this way would involve creating a directory that house another set of JSON files in the Malay language.

2. Introduce more fields into the JSON file itself and use _en and _zsm postfix to denote the language. So for example, instead of a single description string in the Selangor.json there would be two. One for the English description and another for the Malay description. (This just means, putting an extra description_zsm in the json file itself)

Both ways have their benefits and their disadvantages.

Notes.

It is indeed possible to use the Content-Negotiation strategy as mentioned here but it was decided not to do so.

30/09/2022 - Included notes regarding Content Negotiation as mentioned in the Stack Overflow post. Also edited post for clarity.

There is a fair amount of data available from the Malaysia Open Data website

It would be great if the number of vehicles on road can be added to the API. The data itself can be obtained from here. However, there might be some data missing or the information there might be incomplete. If so, these should be marked as "NA". Please note that there are two numbers, the number of active vehicles and the number of inactive vehicles.

Currently, it can be seen that, there is an entry at

https://github.com/JianLoong/malaysia-api/blob/main/state/v1/selangor.json which actually leads to this end point which deployed to gh-pages.

So, a Johor.json should be created which contains information with regards to the state Johor.

Information with regards to the state can be obtained here.

The JSON file should that contains the information should have similar output with the Selangor.json.

Currently, it can be seen that, there is an entry at

https://github.com/JianLoong/malaysia-api/blob/main/state/v1/selangor.json which actually leads to this end point.

So, for example, a malacca.json should be created which contains information with regards to the state of Malacca.

Information with regards to the state can be obtained here.

This should be applied to all the remaining states which does not have an entry, found at the readme or not present in the state directory.

The JSON file should contain the information should have similar output with the Selangor.json. Please also remember that the JSON file should be valid. (Please use a JSON validator to ensure that it is a valid JSON file).

If possible all remaining states are included into the repository so that #2 is resolved as well.

Edit - Updated to mention #2
Edit - Updated with regards to issue #23
Edit - Updated issue so that more data is added instead of single one at each time

Previously in #14 and #17 which added information on Kuala Lumpur, Labuan and Putrajaya, the administrative division was incorrectly labeled as "State of Malaysia". They are however not considered to be states but as federal territories instead.

The correction would be as follows (for the administrative division)

Labuan - Federal Territory of Labuan
Kuala Lumpur - Federal Territory of Kuala Lumpur
Putrajaya - Federal Territory of Putrajaya

This will also line up the entries so that the data is similar to the ones in the all.json file.

Currently, it can be seen that, there is an entry at

https://github.com/JianLoong/malaysia-api/blob/main/state/v1/selangor.json which actually leads to this end point which is deployed via gh-pages.

So, a Kelantan.json should be created which contains information with regards to the state of Kelantan.

Information with regards to the state can be obtained here.

The JSON file should contain the information should have similar output with the Selangor.json. Please also remember that the JSON file should be valid. (Please use a JSON validator to ensure that it is a valid JSON file).

Currently most of the data types in the JSON data stores for certain numeric fields are string however, this should not be the case, these should be numbers instead.

Take a look at the state/v1/all.json file for example below. The population and total_area should be numbers instead of strings.

    {
        "administrative_division": "State of Malaysia",
        "state": "Johor",
        "capital": "Johor Bahru",
        "royal_capital": "Muar",
        "population": "3,794,000", <---------------- This should be number
        "total_area": "19,166",  <----------------       This should be number
        "licence_plate_prefix": "J",
        "phone_area_code": "07, 06 (Muar & Tangkak)",
        "abbreviation": "JHR",
        "ISO": "MY-01",
        "FIPS": "MY01",
        "HDI": "0.818",
        "region": "Peninsular Malaysia",
        "head_of_state": "Sultan",
        "head_of_goverment": "Menteri Besar"
    },

This should be corrected for all entries.

This issue is related to #44

The flag URL has been fixed however, the "crest_url" which points to the Wikipedia website entry has not been addressed.

For example in the file state/v1/johor.json the

"crest_url" information is currenty

"https://en.wikipedia.org/wiki/Johor#/media/File:Coat_of_arms_of_Johor.svg"

when it should be instead

"https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Coat_of_arms_of_Johor.svg/1280px-Coat_of_arms_of_Johor.svg.png"

This is the same as several other entries.

Missing crest_url from other states should also be added to handle this issue.

Currently, it can be seen that, there is an entry at

https://github.com/JianLoong/malaysia-api/blob/main/state/v1/selangor.json which actually leads to this end point which is deployed via gh-pages.

So, a Perlis.json should be created which contains information with regards to the state Perlis.

Information with regards to the state can be obtained here.

The JSON file should contain the information should have similar output with the Selangor.json. Please also remember that the JSON file should be valid. (Please use a JSON validator to ensure that it is a valid JSON file).