OpenDOSM API Endpoint

GET https://api.data.gov.my/opendosm

What does OpenDOSM API do?

The OpenDOSM API is designed to allow users to programmatically access OpenDOSM data catalogue. This API is tailored for users who are interested exclusively in OpenDOSM data. For more general data across data.gov.my, please refer to Data Catalogue API.

How to Find Available Datasets

To access specific OpenDOSM data catalogue, you need to specify the id parameter in your request URL. It's a required parameter, here's an example of how to use it:

GET https://api.data.gov.my/opendosm?id=cpi_core

To discover the available datasets, visit the OpenDOSM Data Catalogue page (opens in a new tab), where datasets are categorised and listed. To find out more about each dataset, click on the dataset page. On each dataset page, there is a section at the bottom titled "Sample OpenAPI query," which contains the necessary id for each data catalogue. If a data catalogue is not available through the API, it will be explicitly mentioned.

Request Query & Response Format

To filter and request data, use the standard filtering operations in the Request Query. You can find information about the available filterable columns in the Metadata section under each Data Catalogue page. For information on how the API responds to your requests, refer to the Response Format section.

Example Request

Let's walk through an example using the cpi_core resource:

1. Finding the Resource

Go to the OpenDOSM Data Catalogue page and find the Core CPI Overall dataset (opens in a new tab). You'll find the id value, "cpi_core," in the "Sample OpenAPI query" section at the bottom of the page. We will use this id for our example.

2. Sending the API Request

To fetch data from the API, use the following curl command. Open your terminal and enter this command:

curl --location 'http://api.data.gov.my/opendosm?id=cpi_core&limit=3'

Executing this command will send a request to the API, specifically targeting the cpi_core dataset, and limiting the response to the first 3 records. For more available filters, please refer to Request Query section.

3. Understanding the Response

To make sense of the API's response, you can refer to the Response Format section. It provides a detailed explanation of what the API response means. In this example, the total length of this list will be 3, as specified by the limit parameter.