Others API

User Interface

Automation

Dataflow

How to retrieve data?

1. Navigate to the API page you want to query, then click the Preview button for the API you wish to use.

1. Please enter the request parameters below, then click the Preview button.

1. After entering valid input values, click the Preview button. A new window will open displaying the data. Once you've confirmed the data retrieval, copy the URL from your browser's address bar.

1. Please paste the copied URL into the form below.

1. Please specify the data path to extract after calling the API. Refer to the instructions below for how to define the path.

Why do I need to specify a data path?

Each API provided by the Public Data Portal may return data in different structures, depending on its purpose and the institution that developed it. Therefore, you must review the retrieved data and manually define the data path to extract the relevant information.

• The data to be retrieved must be in array format, which is used to manage groups of related data.

For XML format data, an example may look like this:

In the case of XML data, if the row element under PublicToiletsBefore2017 is repeated, it is interpreted as an array. So, the correct data path would be:PublicToiletsBefore2017.row

• For JSON format data, here's an example:

The part enclosed in square brackets [ ] is referred to as an array. In the example provided, the array is returned inside the item object within the MetalService object.

Therefore, the correct data path is: MetalService.item

Field	Description	Comment
API Endpoint	Open API Endpoint	Refer to "How to get API endpoint?" section below this page
Parameters	Search Parameters (Optional)	JSON Object Type
Responses Path	Responses data path for extract datas (Optional)

How to get API endpoint?

Enter the End Point from the details of the Open API you applied for.

If the API is not returning data, please check the following:

1. Verify that the correct API Key is entered.

   Some APIs require a separately issued API Key—ensure you're using the appropriate one.

2. Check if you’ve exceeded the daily API call limit.

   The general limit is 10,000 calls per day, but this may vary by organization.

3. Temporary connection issues may cause failed calls.

   Try again after waiting a few moments.

4. Ensure the data you are trying to retrieve is in array format.

   Only array-based responses can be processed correctly.

5. Non-standard APIs (not following official API structures)

   may not be supported due to security and system stability considerations.